Exchange Maven Facade icon

Exchange Maven Facade

2.0.x
(0 reviews)

Consuming REST API Specifications

To consume a REST API specification using Maven, add the asset groupId, artifactId, and version as a dependency in your pom.xml file. You can use two classifiers:

  • raml: Downloads a zip file with the REST API specification (the package won't include any dependencies that were used to build that specification). The associated pom.xml file contains the API fragments as dependencies.
  • fat-raml: Downloads a zip file with the complete REST API specification (the package includes all dependencies that were used to build that specification). The associated pom file also contains the API fragments as dependencies.

In these examples, we are downloading a zip file, the type must be zip:

<dependency>
  <groupId>68ef9520-24e9-4cf2-b2f5-620025690913</groupId>
  <artifactId>pega-api</artifactId>
  <version>2.0.8</version>
  <classifier>raml</classifier>
  <type>zip</type>
</dependency>
<dependency>
  <groupId>68ef9520-24e9-4cf2-b2f5-620025690913</groupId>
  <artifactId>pega-api</artifactId>
  <version>2.0.8</version>
  <classifier>fat-raml</classifier>
  <type>zip</type>
</dependency>

Reviews